事件推送
注册回调,你将实时接收事件报警。
要注册回调,你只需要提供两件事。
首先,你需要指定语言。IETF BCP 47标准:{语言}-{地区}
。例如:en-US。
其次,提供回调。回调包含用于认证的url和appId。url格式如https://{{host}}/xx/xx
。appId格式如"24416c36-d9c7-4d74-a047-d6ca461fxxxx"。此外,http方法应为POST。
当事件发生时 ,你的回调将立即被调用。
示例curl命令:
curl -X POST "{{host}}" \
-H "accept: */*" \
-H "Content-Type: application/json" \
-d '{
"appId": "{{appId}}",
"payload": {
"content": {
"endTime": "",
"incidentCode": "1011",
"incidentId": "74bbc189-3313-4665-8204-9fbe45dfxxxx",
"incidentLevel": "H2",
"incidentName": "Clean water full",
"incidentStatus": 1,
"startTime": "2023-01-14T02:09:28Z",
"taskId": "74bbc189-3313-4665-8204-9fbe45dfxxxx",
"subTaskId": "74bbc189-3313-4665-8204-9fbe45dfxxxx",
"taskInstanceId": "74bbc189-3313-4665-8204-9fbe45dfxxxx",
"taskName": "74bbc189-3313-4665-8204-9fbe45dfxxxx",
"mapId": "74bbc189-3313-4665-8204-9fbe45dfxxxx",
"mapName": "74bbc189-3313-4665-8204-9fbe45dfxxxx"
},
"modelTypeCode": "Scrubber 50H",
"serialNumber": "ITEST00-0000-000-XXXX"
}
}'
参数描述:
字段名称 | 字段类型 | 字段描述 | 示例 |
---|---|---|---|
appId | String | 用于认证 | "24416c36-d9c7-4d74-a047-d6ca461fxxxx" |
payload | Object | 事件消息内容 | |
payload.serialNumber | String | 机器人序列号 | "TEST00-0000-000-XXXX" |
payload.modelTypeCode | String | 机器人型号代码 | "Scrubber 50H" |
payload.content | Object | 事件内容 | |
payload.content.incidentCode | String | 事件代码 | "1011" |
payload.content.incidentName | String | 事件名称 | "Clean water full" |
payload.content.incidentLevel | String | 事件等级 | "H2" |
payload.content.incidentId | String | 事件ID | "c084a905-597e-4085-90dd-ecab697dxxxx" |
payload.content.incidentStatus | int | 事件状态,1 报警,0 恢复 | 1 |
payload.content.startTime | String | 事件开始时间,UTC时间 | "2023-01-14T02:09:28Z" |
payload.content.endTime | String | 事件结束时间,UTC时间。如果事件未恢复,结束时间为空字符串 | "2023-01-14T02:09:28Z" 或 "" |
payload.content.taskId | String | 事件发生时,机器人正在执行的任务id | "c084a905-597e-4085-90dd-ecab697dxxxx" |
payload.content.subTaskId | String | 事件发生时,机器人正在执行的子任务id | "c084a905-597e-4085-90dd-ecab697dxxxx" |
payload.content.taskInstanceId | String | 事件发生时,机器人正在执行的任务实例id | "c084a905-597e-4085-90dd-ecab697dxxxx" |
payload.content.taskName | String | 事件发生时,机器人正在执行的任务名称 | "task1" |
payload.content.mapId | String | 事件发生时,机器人所在地图的id | "c084a905-597e-4085-90dd-ecab697dxxxx" |
payload.content.mapName | String | 事件发生时,机器人所在的地图名称 | "map1" |
payload.content.incidentLevel:
值 | 名称 | 描述 |
---|---|---|
H0 | 事件 | 这不是报警,仅是事件通知 |
H1 | 状态 | 埋点统计 |
H2 | 状态 | 机器人的常规状态,用户无需指导即可解决 |
H3 | 警告 | 不影响机器人任务,用户可以解决 |
H4 | 协助,问题 | 影响机器人任务,用户可以解决 |
H5 | 隐患 | 不影响机器人任务,用户无法解决 |
H6 | 故障 | 影响机器人任务,用户无法解决 |
H7 | 质量问题 | 严重故障 |